docs: add function docstring and readme example#31
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
@sbillinge, it's ready for review. Also, do we want to deploy an online website to host the documentation? |
|
I can make it publishable but I think we have to build the docs using the CI to generate the |
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
This looks great! Just a few grumpy comments....
| Parameters | ||
| ---------- | ||
| input_data_dir : str | ||
| Path to the directory containing input PDF profile files. |
There was a problem hiding this comment.
I am not sure if you remember, but all these should begin with The. If you are using LLM to help with these, that is fine but please can you train your LLM to do this! :)
There was a problem hiding this comment.
sorry... I will remember this next time.
| Default is None. | ||
| xmin : float | ||
| Minimum x-value for the PDF profile. | ||
| Default is the value prased from the input file. |
| self._init_plots() | ||
|
|
||
| def init_plots(self): | ||
| def _init_plots(self): |
There was a problem hiding this comment.
is this an initialization function? In which case I think _initialize_plots is more descriptive
ycexiao
left a comment
ycexiao
left a comment
There was a problem hiding this comment.
@sbillinge, it's ready for review.
| Methods | ||
| ------- | ||
| init_profile(profile_path, qmin=None, qmax=None, xmin=None, xmax=None, dx=None) | ||
| initialize_profile(profile_path, qmin=None, qmax=None, xmin=None, xmax=None, dx=None) |
| Parameters | ||
| ---------- | ||
| input_data_dir : str | ||
| The path to the directory containing input PDF profile files. |
| Default is the value parsed from the input file. | ||
| xmax : float | ||
| The maximum x-value for the PDF profile. | ||
| Default is the value parsed from the input file. |
There was a problem hiding this comment.
Typo fixed: prased -> parsed
2 participants
What problem does this PR address?
Closes #3
Docstring for
SequentialCMIRunnerand examples are addedWhat should the reviewer(s) do?
Please see the modifications.